<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: CommitResponse.html 939 2015-05-29 01:16:17Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.raft.msg;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.base.Preconditions;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.nio.ByteBuffer;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jsimpledb.kv.raft.Timestamp;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jsimpledb.util.LongEncoder;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Response to a {@link CommitRequest}.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * If the request was successful, the leader returns the term and index of the log entry that, when committed (in the Raft sense),<a name="line.21"></a>
<span class="sourceLineNo">022</span> * allows the transaction to be committed. This suffices for read-write transactions, because the log entry corresponds<a name="line.22"></a>
<span class="sourceLineNo">023</span> * directly to the transaction's mutations.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * In order to support linearizable semantics for read-only transactions, which do not create new log entries, in addition<a name="line.26"></a>
<span class="sourceLineNo">027</span> * a {@linkplain #getCommitLeaderLeaseTimeout minimum leader lease timeout} value is included; the transaction can then<a name="line.27"></a>
<span class="sourceLineNo">028</span> * be committed after receiving an {@link AppendRequest} whose {@linkplain AppendRequest#getLeaderLeaseTimeout<a name="line.28"></a>
<span class="sourceLineNo">029</span> * leader lease timeout} is at least this high. In most cases, such an {@link AppendRequest} will have already been received,<a name="line.29"></a>
<span class="sourceLineNo">030</span> * so the transaction can be committed with a single round trip.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class CommitResponse extends Message {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    private final long txId;<a name="line.34"></a>
<span class="sourceLineNo">035</span>    private final long commitTerm;<a name="line.35"></a>
<span class="sourceLineNo">036</span>    private final long commitIndex;<a name="line.36"></a>
<span class="sourceLineNo">037</span>    private final Timestamp commitLeaderLeaseTimeout;               // minimum required value we must see to commit<a name="line.37"></a>
<span class="sourceLineNo">038</span>    private final String errorMessage;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>// Constructors<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Constructor for success case, when there is no minimum leader lease timeout required for commit<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * (read-write transaction, or read-only transaction occurring within the current leader lease timeout).<a name="line.44"></a>
<span class="sourceLineNo">045</span>     *<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @param clusterId cluster ID<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @param senderId sending node identity<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @param recipientId identity of recipient<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param term current term<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @param txId recipient's original transaction ID<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * @param commitTerm transaction commit term<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @param commitIndex transaction commit index<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    public CommitResponse(int clusterId, String senderId, String recipientId, long term, long txId,<a name="line.54"></a>
<span class="sourceLineNo">055</span>      long commitTerm, long commitIndex) {<a name="line.55"></a>
<span class="sourceLineNo">056</span>        this(clusterId, senderId, recipientId, term, txId, commitTerm, commitIndex, null);<a name="line.56"></a>
<span class="sourceLineNo">057</span>    }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Constructor for success case when a minimum leader lease timeout is required for commit (read-only transaction<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * when leader has not heard from a majority of followers in at least a minimum election timeout.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     *<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @param clusterId cluster ID<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @param senderId sending node identity<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param recipientId identity of recipient<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @param term current term<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * @param txId recipient's original transaction ID<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * @param commitTerm transaction commit term<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @param commitIndex transaction commit index<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * @param commitLeaderLeaseTimeout minimum leader lease time required for commit, or null for none<a name="line.70"></a>
<span class="sourceLineNo">071</span>     */<a name="line.71"></a>
<span class="sourceLineNo">072</span>    public CommitResponse(int clusterId, String senderId, String recipientId, long term,<a name="line.72"></a>
<span class="sourceLineNo">073</span>      long txId, long commitTerm, long commitIndex, Timestamp commitLeaderLeaseTimeout) {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        this(clusterId, senderId, recipientId, term, txId, commitTerm, commitIndex, commitLeaderLeaseTimeout, null);<a name="line.74"></a>
<span class="sourceLineNo">075</span>    }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Constructor for error case.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param clusterId cluster ID<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param senderId sending node identity<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param recipientId identity of recipient<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param term current term<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @param txId recipient's original transaction ID<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @param errorMessage failure error message<a name="line.85"></a>
<span class="sourceLineNo">086</span>     */<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public CommitResponse(int clusterId, String senderId, String recipientId, long term, long txId, String errorMessage) {<a name="line.87"></a>
<span class="sourceLineNo">088</span>        this(clusterId, senderId, recipientId, term, txId, 0, 0, null, errorMessage);<a name="line.88"></a>
<span class="sourceLineNo">089</span>        Preconditions.checkArgument(errorMessage != null, "null errorMessage");<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    private CommitResponse(int clusterId, String senderId, String recipientId, long term, long txId,<a name="line.92"></a>
<span class="sourceLineNo">093</span>      long commitTerm, long commitIndex, Timestamp commitLeaderLeaseTimeout, String errorMessage) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        super(Message.COMMIT_RESPONSE_TYPE, clusterId, senderId, recipientId, term);<a name="line.94"></a>
<span class="sourceLineNo">095</span>        this.txId = txId;<a name="line.95"></a>
<span class="sourceLineNo">096</span>        this.commitTerm = commitTerm;<a name="line.96"></a>
<span class="sourceLineNo">097</span>        this.commitIndex = commitIndex;<a name="line.97"></a>
<span class="sourceLineNo">098</span>        this.commitLeaderLeaseTimeout = commitLeaderLeaseTimeout;<a name="line.98"></a>
<span class="sourceLineNo">099</span>        this.errorMessage = errorMessage;<a name="line.99"></a>
<span class="sourceLineNo">100</span>        this.checkArguments();<a name="line.100"></a>
<span class="sourceLineNo">101</span>    }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    CommitResponse(ByteBuffer buf) {<a name="line.103"></a>
<span class="sourceLineNo">104</span>        super(Message.COMMIT_RESPONSE_TYPE, buf);<a name="line.104"></a>
<span class="sourceLineNo">105</span>        this.txId = LongEncoder.read(buf);<a name="line.105"></a>
<span class="sourceLineNo">106</span>        this.commitTerm = LongEncoder.read(buf);<a name="line.106"></a>
<span class="sourceLineNo">107</span>        this.commitIndex = LongEncoder.read(buf);<a name="line.107"></a>
<span class="sourceLineNo">108</span>        this.commitLeaderLeaseTimeout = Message.getBoolean(buf) ? Message.getTimestamp(buf) : null;<a name="line.108"></a>
<span class="sourceLineNo">109</span>        this.errorMessage = Message.getBoolean(buf) ? Message.getString(buf) : null;<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this.checkArguments();<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span>    void checkArguments() {<a name="line.114"></a>
<span class="sourceLineNo">115</span>        super.checkArguments();<a name="line.115"></a>
<span class="sourceLineNo">116</span>        Preconditions.checkArgument(this.txId != 0);<a name="line.116"></a>
<span class="sourceLineNo">117</span>        Preconditions.checkArgument(this.commitTerm &gt;= 0);<a name="line.117"></a>
<span class="sourceLineNo">118</span>        Preconditions.checkArgument(this.commitIndex &gt;= 0);<a name="line.118"></a>
<span class="sourceLineNo">119</span>        Preconditions.checkArgument(this.errorMessage == null || this.commitLeaderLeaseTimeout == null);<a name="line.119"></a>
<span class="sourceLineNo">120</span>    }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>// Properties<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * Get the sender's ID for the transaction.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     *<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @return transaction ID<a name="line.127"></a>
<span class="sourceLineNo">128</span>     */<a name="line.128"></a>
<span class="sourceLineNo">129</span>    public long getTxId() {<a name="line.129"></a>
<span class="sourceLineNo">130</span>        return this.txId;<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Determine whether the request was successful.<a name="line.134"></a>
<span class="sourceLineNo">135</span>     *<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * @return true for success, false for error<a name="line.136"></a>
<span class="sourceLineNo">137</span>     */<a name="line.137"></a>
<span class="sourceLineNo">138</span>    public boolean isSuccess() {<a name="line.138"></a>
<span class="sourceLineNo">139</span>        return this.errorMessage == null;<a name="line.139"></a>
<span class="sourceLineNo">140</span>    }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span>    /**<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * Get the commit term for the transaction. This is always the same as the term of the sender.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @return transaction commit term<a name="line.145"></a>
<span class="sourceLineNo">146</span>     */<a name="line.146"></a>
<span class="sourceLineNo">147</span>    public long getCommitTerm() {<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return this.commitTerm;<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Get the commit index for the transaction.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return transaction commit index, or zero if there was an error<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    public long getCommitIndex() {<a name="line.156"></a>
<span class="sourceLineNo">157</span>        return this.commitIndex;<a name="line.157"></a>
<span class="sourceLineNo">158</span>    }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span>    /**<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * Get the minimum required leader lease timeout value to commit, if any.<a name="line.161"></a>
<span class="sourceLineNo">162</span>     *<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * @return minimum leader lease timeout, or null if there is none<a name="line.163"></a>
<span class="sourceLineNo">164</span>     */<a name="line.164"></a>
<span class="sourceLineNo">165</span>    public Timestamp getCommitLeaderLeaseTimeout() {<a name="line.165"></a>
<span class="sourceLineNo">166</span>        return this.commitLeaderLeaseTimeout;<a name="line.166"></a>
<span class="sourceLineNo">167</span>    }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>    /**<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * Get the error message in case of failure.<a name="line.170"></a>
<span class="sourceLineNo">171</span>     *<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * @return failure message, or null if there was no error<a name="line.172"></a>
<span class="sourceLineNo">173</span>     */<a name="line.173"></a>
<span class="sourceLineNo">174</span>    public String getErrorMessage() {<a name="line.174"></a>
<span class="sourceLineNo">175</span>        return this.errorMessage;<a name="line.175"></a>
<span class="sourceLineNo">176</span>    }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span>// Message<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span>    @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span>    public boolean isLeaderMessage() {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        return true;<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span>    public void visit(MessageSwitch handler) {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        handler.caseCommitResponse(this);<a name="line.187"></a>
<span class="sourceLineNo">188</span>    }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span>    @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span>    public void writeTo(ByteBuffer dest) {<a name="line.191"></a>
<span class="sourceLineNo">192</span>        super.writeTo(dest);<a name="line.192"></a>
<span class="sourceLineNo">193</span>        LongEncoder.write(dest, this.txId);<a name="line.193"></a>
<span class="sourceLineNo">194</span>        LongEncoder.write(dest, this.commitTerm);<a name="line.194"></a>
<span class="sourceLineNo">195</span>        LongEncoder.write(dest, this.commitIndex);<a name="line.195"></a>
<span class="sourceLineNo">196</span>        Message.putBoolean(dest, this.commitLeaderLeaseTimeout != null);<a name="line.196"></a>
<span class="sourceLineNo">197</span>        if (this.commitLeaderLeaseTimeout != null)<a name="line.197"></a>
<span class="sourceLineNo">198</span>            Message.putTimestamp(dest, this.commitLeaderLeaseTimeout);<a name="line.198"></a>
<span class="sourceLineNo">199</span>        Message.putBoolean(dest, this.errorMessage != null);<a name="line.199"></a>
<span class="sourceLineNo">200</span>        if (this.errorMessage != null)<a name="line.200"></a>
<span class="sourceLineNo">201</span>            Message.putString(dest, this.errorMessage);<a name="line.201"></a>
<span class="sourceLineNo">202</span>    }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span>    @Override<a name="line.204"></a>
<span class="sourceLineNo">205</span>    protected int calculateSize() {<a name="line.205"></a>
<span class="sourceLineNo">206</span>        return super.calculateSize()<a name="line.206"></a>
<span class="sourceLineNo">207</span>          + LongEncoder.encodeLength(this.txId)<a name="line.207"></a>
<span class="sourceLineNo">208</span>          + LongEncoder.encodeLength(this.commitTerm)<a name="line.208"></a>
<span class="sourceLineNo">209</span>          + LongEncoder.encodeLength(this.commitIndex)<a name="line.209"></a>
<span class="sourceLineNo">210</span>          + 1<a name="line.210"></a>
<span class="sourceLineNo">211</span>          + (this.commitLeaderLeaseTimeout != null ? Message.calculateSize(this.commitLeaderLeaseTimeout) : 0)<a name="line.211"></a>
<span class="sourceLineNo">212</span>          + 1<a name="line.212"></a>
<span class="sourceLineNo">213</span>          + (this.errorMessage != null ? Message.calculateSize(this.errorMessage) : 0);<a name="line.213"></a>
<span class="sourceLineNo">214</span>    }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span>// Object<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    @Override<a name="line.218"></a>
<span class="sourceLineNo">219</span>    public String toString() {<a name="line.219"></a>
<span class="sourceLineNo">220</span>        final boolean success = this.errorMessage == null;<a name="line.220"></a>
<span class="sourceLineNo">221</span>        return this.getClass().getSimpleName()<a name="line.221"></a>
<span class="sourceLineNo">222</span>          + "[\"" + this.getSenderId() + "\"-&gt;\"" + this.getRecipientId() + "\""<a name="line.222"></a>
<span class="sourceLineNo">223</span>          + ",clusterId=" + String.format("%08x", this.getClusterId())<a name="line.223"></a>
<span class="sourceLineNo">224</span>          + ",term=" + this.getTerm()<a name="line.224"></a>
<span class="sourceLineNo">225</span>          + ",txId=" + this.txId<a name="line.225"></a>
<span class="sourceLineNo">226</span>          + (success ?<a name="line.226"></a>
<span class="sourceLineNo">227</span>            ",commit=" + this.commitTerm + "/" + this.commitIndex<a name="line.227"></a>
<span class="sourceLineNo">228</span>             + (this.commitLeaderLeaseTimeout != null ? "@" + this.commitLeaderLeaseTimeout : "") :<a name="line.228"></a>
<span class="sourceLineNo">229</span>            ",error=\"" + this.errorMessage + "\"")<a name="line.229"></a>
<span class="sourceLineNo">230</span>          + "]";<a name="line.230"></a>
<span class="sourceLineNo">231</span>    }<a name="line.231"></a>
<span class="sourceLineNo">232</span>}<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>




























































</pre>
</div>
</body>
</html>
